<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="PopUpManager,mx.managers.PopUpManager,addPopUp,bringToFront,centerPopUp,createPopUp,removePopUp" name="keywords">
<title>mx.managers.PopUpManager</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'PopUpManager - Zentrum virtUOS: virtPresenter';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">virtPresenter AsDoc</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?mx/managers/PopUpManager.html&amp;mx/managers/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;PopUpManager</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class PopUpManager"); titleBar_setSubNav(false,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">mx.managers</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class PopUpManager</td>
</tr>
</table>
<p></p>
  The PopUpManager singleton class creates new top-level windows and
  places or removes those windows from the layer on top of all other
  visible windows.  See the SystemManager for a description of the layering.
  It is used for popup dialogs, menus, and dropdowns in the ComboBox control 
  and in similar components.
 
  <p>The PopUpManager also provides modality, so that windows below the popup
  cannot receive mouse events, and also provides an event if the user clicks
  the mouse outside the window so the developer can choose to dismiss
  the window or warn the user.</p>
 
  <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="PopUpManagerChildList.html" target="">PopUpManagerChildList</a>
</div>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addPopUp()">addPopUp</a>(window:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a>, parent:DisplayObject, modal:Boolean = false, childList:String = null):void</div>
<div class="summaryTableDescription">[static]
      Pops up a top-level window.</div>
</td><td class="summaryTableOwnerCol">PopUpManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#bringToFront()">bringToFront</a>(popUp:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</div>
<div class="summaryTableDescription">[static]
      Makes sure a popup window is higher than other objects in its child list
      The SystemManager does this automatically if the popup is a top level window
      and is moused on, 
      but otherwise you have to take care of this yourself.</div>
</td><td class="summaryTableOwnerCol">PopUpManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#centerPopUp()">centerPopUp</a>(popUp:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</div>
<div class="summaryTableDescription">[static]
      Centers a popup window over whatever window was used in the call 
      to the <code>createPopUp()</code> or <code>addPopUp()</code> method.</div>
</td><td class="summaryTableOwnerCol">PopUpManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#createPopUp()">createPopUp</a>(parent:DisplayObject, className:Class, modal:Boolean = false, childList:String = null):<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a>
</div>
<div class="summaryTableDescription">[static]
      Creates a top-level window and places it above other windows in the
      z-order.</div>
</td><td class="summaryTableOwnerCol">PopUpManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removePopUp()">removePopUp</a>(popUp:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</div>
<div class="summaryTableDescription">[static]
      Removes a popup window popped up by 
      the <code>createPopUp()</code> or <code>addPopUp()</code> method.</div>
</td><td class="summaryTableOwnerCol">PopUpManager</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addPopUp()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addPopUp</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public static function addPopUp(window:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a>, parent:DisplayObject, modal:Boolean = false, childList:String = null):void</code><p>
      Pops up a top-level window.
      It is good practice to call <code>removePopUp()</code> to remove popups
      created by using the <code>addPopUp()</code> method.
      If the class implements IFocusManagerContainer, the window will have its
      own FocusManager so that, if the user uses the TAB key to navigate between
      controls, only the controls in the window will be accessed.
           </p><p><b>Example</b></p> 
           <pre>var tw = new TitleWindow();
        tw.title = "My Title";
        mx.managers.PopUpManager.addPopUp(tw, pnl, false);</pre>
           <p>Creates a popup window using the <code>tw</code> instance of the 
      TitleWindow class and <code>pnl</code> as the Sprite for determining
      where to place the popup.
      It is defined to be a non-modal window.</p>
      
      <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">window</span>:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a></code> &mdash; The IFlexDisplayObject to be popped up.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">parent</span>:DisplayObject</code> &mdash; DisplayObject to be used for determining which SystemManager's layers
      to use and optionally  the reference point for centering the new
      top level window.  It may not be the actual parent of the popup as all popups
      are parented by the SystemManager.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">modal</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If <code>true</code>, the window is modal which means that
      the user will not be able to interact with other popups until the window
      is removed.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">childList</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The child list in which to add the pop-up.
      One of <code>PopUpManagerChildList.APPLICATION</code>, 
      <code>PopUpManagerChildList.POPUP</code>, 
      or <code>PopUpManagerChildList.PARENT</code> (default).
           </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="PopUpManagerChildList.html" target="">PopUpManagerChildList</a>
</div>
</div>
<a name="bringToFront()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">bringToFront</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function bringToFront(popUp:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</code><p>
      Makes sure a popup window is higher than other objects in its child list
      The SystemManager does this automatically if the popup is a top level window
      and is moused on, 
      but otherwise you have to take care of this yourself.
           </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">popUp</span>:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a></code> &mdash; IFlexDisplayObject representing the popup.
     </td>
</tr>
</table>
</div>
<a name="centerPopUp()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">centerPopUp</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function centerPopUp(popUp:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</code><p>
      Centers a popup window over whatever window was used in the call 
      to the <code>createPopUp()</code> or <code>addPopUp()</code> method.
           </p><p>Note that the position of the popup window may not
      change immediately after this call since Flex may wait to measure and layout the
      popup window before centering it.</p>
           <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">popUp</span>:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a></code> &mdash; IFlexDisplayObject representing the popup.
     </td>
</tr>
</table>
</div>
<a name="createPopUp()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">createPopUp</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function createPopUp(parent:DisplayObject, className:Class, modal:Boolean = false, childList:String = null):<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a></code><p>
      Creates a top-level window and places it above other windows in the
      z-order.
      It is good practice to call the <code>removePopUp()</code> method 
      to remove popups created by using the <code>createPopUp()</code> method.
           If the class implements IFocusManagerContainer, the window will have its
      own FocusManager so that, if the user uses the TAB key to navigate between
      controls, only the controls in the window will be accessed.
           </p><p><b>Example</b></p> 
           <pre>pop = mx.managers.PopUpManager.createPopUp(pnl, TitleWindow, false); </pre>
      
      <p>Creates a popup window based on the TitleWindow class, using <code>pnl</code> as the MovieClip 
      for determining where to place the popup. It is defined to be a non-modal window 
      meaning that other windows can receive mouse events</p>
           <span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">parent</span>:DisplayObject</code> &mdash; DisplayObject to be used for determining which SystemManager's layers
      to use and optionally the reference point for centering the new
      top level window.  It may not be the actual parent of the popup as all popups
      are parented by the SystemManager.
     
      </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">className</span>:Class</code> &mdash; Class of object that is to be created for the popup.
      The class must implement IFlexDisplayObject.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">modal</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If <code>true</code>, the window is modal which means that
      the user will not be able to interact with other popups until the window
      is removed.
           </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">childList</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The child list in which to add the popup.
      One of <code>PopUpManagerChildList.APPLICATION</code>, 
      <code>PopUpManagerChildList.POPUP</code>, 
      or <code>PopUpManagerChildList.PARENT</code> (default).
           </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a></code> &mdash; 
                        Reference to new top-level window.
           
                        
                     </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="PopUpManagerChildList.html" target="">PopUpManagerChildList</a>
</div>
</div>
<a name="removePopUp()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removePopUp</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static function removePopUp(popUp:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</code><p>
      Removes a popup window popped up by 
      the <code>createPopUp()</code> or <code>addPopUp()</code> method.
      
      </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">popUp</span>:<a href="../core/IFlexDisplayObject.html">IFlexDisplayObject</a></code> &mdash; The IFlexDisplayObject representing the popup window.
     </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
